<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - WebVideoPlayerController</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/AndroidKeyHandler.html">AndroidKeyHandler</a></li>
	
	<li><a href="../symbols/FocusableItem.html">FocusableItem</a></li>
	
	<li><a href="../symbols/FocusController.html">FocusController</a></li>
	
	<li><a href="../symbols/FullscreenPage.html">FullscreenPage</a></li>
	
	<li><a href="../symbols/GenericVideoPlayerController.html">GenericVideoPlayerController</a></li>
	
	<li><a href="../symbols/GridController.html">GridController</a></li>
	
	<li><a href="../symbols/GridFocusableItem.html">GridFocusableItem</a></li>
	
	<li><a href="../symbols/IndexPage.html">IndexPage</a></li>
	
	<li><a href="../symbols/NativeVideoPlayerController.html">NativeVideoPlayerController</a></li>
	
	<li><a href="../symbols/SideMenuFocusableItem.html">SideMenuFocusableItem</a></li>
	
	<li><a href="../symbols/SideNavController.html">SideNavController</a></li>
	
	<li><a href="../symbols/VideoCommandFocusableItem.html">VideoCommandFocusableItem</a></li>
	
	<li><a href="../symbols/VideoControlsController.html">VideoControlsController</a></li>
	
	<li><a href="../symbols/VideoDAO.html">VideoDAO</a></li>
	
	<li><a href="../symbols/VideoDataController.html">VideoDataController</a></li>
	
	<li><a href="../symbols/WebVideoPlayerController.html">WebVideoPlayerController</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class WebVideoPlayerController
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				<br />Extends
					<a href="../symbols/GenericVideoPlayerController.html">GenericVideoPlayerController</a>.<br />
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/Workspace_web-to-native-web-app_http-client_js_webVideoPlayerController.js.html">webVideoPlayerController.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class WebVideoPlayerController.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/WebVideoPlayerController.html#constructor">WebVideoPlayerController</a></b>(containerId)
							</div>
							<div class="description">This class handles the video playback via a HTML5 video tag</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class WebVideoPlayerController.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#addNewVideoPlayer">addNewVideoPlayer</a></b>()
								</div>
								<div class="description">Add a new video player to the container ID.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#canPlay">canPlay</a></b>()
								</div>
								<div class="description">This method informs whether the video player has loaded the video and is
ready to play</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#fastForward">fastForward</a></b>()
								</div>
								<div class="description">Method to handle fast forwarding the video</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#getContainerId">getContainerId</a></b>()
								</div>
								<div class="description">Get the ID of the div to place the video tag</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#getDuration">getDuration</a></b>()
								</div>
								<div class="description">Get the duration of the video</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#getElapsedTime">getElapsedTime</a></b>()
								</div>
								<div class="description">Get the amount of video already played</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#getLoadedTime">getLoadedTime</a></b>()
								</div>
								<div class="description">Get the amount of video which is loaded</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#getVideoElement">getVideoElement</a></b>()
								</div>
								<div class="description">Get the video element</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#isPlaying">isPlaying</a></b>()
								</div>
								<div class="description">Check to see if the video is playing</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onDurationChange">onDurationChange</a></b>()
								</div>
								<div class="description">Callback to handle the change in duration of the video</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onEnded">onEnded</a></b>()
								</div>
								<div class="description">Callback when the video ends</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onLoaded">onLoaded</a></b>()
								</div>
								<div class="description">Callback when the video is loaded</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onMouseMove">onMouseMove</a></b>()
								</div>
								<div class="description">Method to handle when the mouse moves</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onProgressUpdate">onProgressUpdate</a></b>()
								</div>
								<div class="description">Update the loaded time of the video and handles any callback methods</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onTimeUpdate">onTimeUpdate</a></b>()
								</div>
								<div class="description">This handles when the loaded time may need updating</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#onVideoUrlChange">onVideoUrlChange</a></b>(url)
								</div>
								<div class="description">Method called to handle a Video URL Change</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#playPause">playPause</a></b>()
								</div>
								<div class="description">Method to handle play / pause toggling</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#rewind">rewind</a></b>()
								</div>
								<div class="description">Method to handle rewinding the video</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#setCanPlay">setCanPlay</a></b>(canPlay)
								</div>
								<div class="description">Sets whether the video player is ready to play</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#setVideoElement">setVideoElement</a></b>(videoElement)
								</div>
								<div class="description">Set the video DOM element</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/WebVideoPlayerController.html#updateLoadedTime">updateLoadedTime</a></b>()
								</div>
								<div class="description">This method updates the loaded time according to the video view</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				<dt>Methods borrowed from class <a href="../symbols/GenericVideoPlayerController.html">GenericVideoPlayerController</a>: </dt><dd><a href="../symbols/GenericVideoPlayerController.html#getPlayerCallback">getPlayerCallback</a>, <a href="../symbols/GenericVideoPlayerController.html#getSkipSpeedSeconds">getSkipSpeedSeconds</a>, <a href="../symbols/GenericVideoPlayerController.html#getVideoUrl">getVideoUrl</a>, <a href="../symbols/GenericVideoPlayerController.html#setPlayerCallback">setPlayerCallback</a>, <a href="../symbols/GenericVideoPlayerController.html#setVideoUrl">setVideoUrl</a></dd>
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>WebVideoPlayerController</b>(containerId)
				</div>
				
				<div class="description">
					This class handles the video playback via a HTML5 video tag
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{String}</span>  <b>containerId</b>
								
							</dt>
								<dd>ID of the div to add the video player to</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="addNewVideoPlayer"> </a>
					<div class="fixedFont">
					
					
					<b>addNewVideoPlayer</b>()
					
					</div>
					<div class="description">
						Add a new video player to the container ID. This is done when ever a new
video url is loaded. This is because there is a bug where the same video
tag cannot handle change src attributes and play video
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="canPlay"> </a>
					<div class="fixedFont">
					
					
					<b>canPlay</b>()
					
					</div>
					<div class="description">
						This method informs whether the video player has loaded the video and is
ready to play
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="fastForward"> </a>
					<div class="fixedFont">
					
					
					<b>fastForward</b>()
					
					</div>
					<div class="description">
						Method to handle fast forwarding the video
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getContainerId"> </a>
					<div class="fixedFont">
					
					
					<b>getContainerId</b>()
					
					</div>
					<div class="description">
						Get the ID of the div to place the video tag
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getDuration"> </a>
					<div class="fixedFont">
					
					
					<b>getDuration</b>()
					
					</div>
					<div class="description">
						Get the duration of the video
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getElapsedTime"> </a>
					<div class="fixedFont">
					
					
					<b>getElapsedTime</b>()
					
					</div>
					<div class="description">
						Get the amount of video already played
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getLoadedTime"> </a>
					<div class="fixedFont">
					
					
					<b>getLoadedTime</b>()
					
					</div>
					<div class="description">
						Get the amount of video which is loaded
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="getVideoElement"> </a>
					<div class="fixedFont">
					
					
					<b>getVideoElement</b>()
					
					</div>
					<div class="description">
						Get the video element
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="isPlaying"> </a>
					<div class="fixedFont">
					
					
					<b>isPlaying</b>()
					
					</div>
					<div class="description">
						Check to see if the video is playing
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onDurationChange"> </a>
					<div class="fixedFont">
					
					
					<b>onDurationChange</b>()
					
					</div>
					<div class="description">
						Callback to handle the change in duration of the video
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onEnded"> </a>
					<div class="fixedFont">
					
					
					<b>onEnded</b>()
					
					</div>
					<div class="description">
						Callback when the video ends
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onLoaded"> </a>
					<div class="fixedFont">
					
					
					<b>onLoaded</b>()
					
					</div>
					<div class="description">
						Callback when the video is loaded
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onMouseMove"> </a>
					<div class="fixedFont">
					
					
					<b>onMouseMove</b>()
					
					</div>
					<div class="description">
						Method to handle when the mouse moves
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onProgressUpdate"> </a>
					<div class="fixedFont">
					
					
					<b>onProgressUpdate</b>()
					
					</div>
					<div class="description">
						Update the loaded time of the video and handles any callback methods
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onTimeUpdate"> </a>
					<div class="fixedFont">
					
					
					<b>onTimeUpdate</b>()
					
					</div>
					<div class="description">
						This handles when the loaded time may need updating
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="onVideoUrlChange"> </a>
					<div class="fixedFont">
					
					
					<b>onVideoUrlChange</b>(url)
					
					</div>
					<div class="description">
						Method called to handle a Video URL Change
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>url</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="playPause"> </a>
					<div class="fixedFont">
					
					
					<b>playPause</b>()
					
					</div>
					<div class="description">
						Method to handle play / pause toggling
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="rewind"> </a>
					<div class="fixedFont">
					
					
					<b>rewind</b>()
					
					</div>
					<div class="description">
						Method to handle rewinding the video
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setCanPlay"> </a>
					<div class="fixedFont">
					
					
					<b>setCanPlay</b>(canPlay)
					
					</div>
					<div class="description">
						Sets whether the video player is ready to play
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>canPlay</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setVideoElement"> </a>
					<div class="fixedFont">
					
					
					<b>setVideoElement</b>(videoElement)
					
					</div>
					<div class="description">
						Set the video DOM element
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{DOMElement}</span> <b>videoElement</b>
									
								</dt>
								<dd>The video DOM element</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="updateLoadedTime"> </a>
					<div class="fixedFont">
					
					
					<b>updateLoadedTime</b>()
					
					</div>
					<div class="description">
						This method updates the loaded time according to the video view
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Aug 28 2012 18:44:07 GMT+0100 (BST)
		</div>
	</body>
</html>
